Motion.SetAxisControlMode method

Sets a control mode of an axis at run time. The control mode must be compatible with the current access mode. Not all axes support control mode changes at run time.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus SetAxisControlMode(
       int Index,
       McControlMode ControlMode
)

Public Function SetAxisControlMode(
       Index As Integer,
       ControlMode As McControlMode
) As KsCommandStatus

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

ControlMode

Type: McControlMode

A control mode for an axis.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

Select different control modes for each axis, or change between control modes for different operations.
Use this method only when an axis is disabled, or if the synchronized control mode is enabled.

Examples

N/A